Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CLI docs #84

Merged
merged 5 commits into from
Jul 16, 2024
Merged

Create CLI docs #84

merged 5 commits into from
Jul 16, 2024

Conversation

chicoxyzzy
Copy link
Contributor

@chicoxyzzy chicoxyzzy commented Jul 10, 2024

This PR adds a new dispatch-docs rule to the Makefile. It builds CLI with a docs build flag.

Markdown is generated in the ./docs directory with Cobra's built-in markdown generator. There's a special case where we have to wrap run command example in the usage by triple backticks to make it look properly in the markdown. This is made possible by adding a isDocsBuild flag.
We can then add those docs to the developer website.

@chicoxyzzy chicoxyzzy force-pushed the gen_docs branch 2 times, most recently from f792e75 to ea91775 Compare July 10, 2024 23:24
@chicoxyzzy chicoxyzzy self-assigned this Jul 11, 2024
@chicoxyzzy chicoxyzzy marked this pull request as draft July 11, 2024 09:24
@chicoxyzzy chicoxyzzy force-pushed the gen_docs branch 2 times, most recently from a102276 to 88fdefd Compare July 11, 2024 10:08
@chicoxyzzy chicoxyzzy marked this pull request as ready for review July 11, 2024 10:10
@chicoxyzzy chicoxyzzy force-pushed the gen_docs branch 2 times, most recently from 87d0ad7 to 9a8e919 Compare July 15, 2024 16:57
cli/generate_docs.go Outdated Show resolved Hide resolved
cli/generate_docs_default.go Outdated Show resolved Hide resolved
cli/main.go Outdated Show resolved Hide resolved
cli/main.go Outdated Show resolved Hide resolved
cli/run.go Outdated Show resolved Hide resolved
Copy link
Contributor

@achille-roussel achille-roussel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

@chicoxyzzy chicoxyzzy merged commit d2be210 into main Jul 16, 2024
3 checks passed
@chicoxyzzy chicoxyzzy deleted the gen_docs branch July 16, 2024 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants